home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / macros / latex209 / contrib / revtex / readme < prev    next >
Text File  |  1992-11-09  |  10KB  |  235 lines
  1. ==========================================================================
  2.      @ASCII-file{
  3.         filename        = "README",
  4.         version         = "3.00",
  5.         date            = "10 November 1992",
  6.         ISO-date        = "1992.11.10",
  7.         time            = "13:41:29.88 EST",
  8.         author          = "American Physical Society,
  9.                            and
  10.                            American Institute of Physics,
  11.                            and
  12.                            Optical Society of America",
  13.         contact         = "Christopher B. Hamlin",
  14.         address         = "APS Publications Liaison Office
  15.                            500 Sunnyside Blvd.
  16.                            Woodbury, NY 11797",
  17.         telephone       = "(516) 576-2390",
  18.         FAX             = "(516) 349-7817",
  19.         email           = "mis@aps.org (Internet)",
  20.         supported       = "yes",
  21.         archived        = "pinet.aip.org/pub/revtex,
  22.                            Niord.SHSU,edu:[FILESERV.REVTEX]",
  23.         keywords        = "REVTeX, version 3.0, README, general information",
  24.         codetable       = "ISO/ASCII",
  25.         checksum        = "24068 234 1381 10322",
  26.         docstring       = "This file is the main README file for the REVTeX
  27.                            v3.0, macro set version 3.0, November 10 1992.
  28.  
  29.                            The checksum field above contains a CRC-16
  30.                            checksum as the first value, followed by the
  31.                            equivalent of the standard UNIX wc (word
  32.                            count) utility output of lines, words, and
  33.                            characters.  This is produced by Robert
  34.                            Solovay's checksum utility."
  35. }
  36. ==========================================================================
  37. %
  38. % ------------------------------------------------------------------- %
  39. %   This file is the main README file for the REVTeX v3.0 macro set   %
  40. %                     version 3.0, November 10 1992                   %
  41. % ------------------------------------------------------------------- %
  42. %
  43. % IMPORTANT NOTICE: You are not allowed to change this readme file.
  44. %
  45.  
  46. Copyright (c) 1992 by American Physical Society, American Institute of
  47.                    Physics, Optical Society of America.  All rights reserved.
  48.  
  49. Other files in this package are copyrighted as stated, and their rights
  50. are reserved by their respective owners.
  51.  
  52. This version of REVTeX is a cooperative product of the American Physical
  53. Society (APS), American Institute of Physics (AIP), and Optical Society of
  54. America (OSA).
  55.  
  56. The Joint Society Task Force, comprised of AIP and AIP Member Societies has
  57. appointed a REVTeX Working Group in order to coordinate the development and
  58. evolution of a joint electronic publishing product and mark-up language
  59. standards amongst the participating societies.
  60.  
  61. Those authors interested in publishing articles in the journals of the
  62. American Astronomical Society should use AASTeX (the LaTeX-based mark-up
  63. developed by the American Astronomical Society). One of the primary objectives
  64. of the REVTeX Working Group is to make REVTeX and AASTeX as similar as
  65. possible. Authors will use many of the same mark-up tags in manuscripts prepared
  66. using either REVTeX or AASTeX. Style differences in the journals---for example,
  67. the manner in which citations are handled (numerical reference or author/date
  68. format)---require that authors actually write different text. Thus, it is
  69. important that authors identify the journal they intend to publish in and use
  70. the appropriate electronic publishing product.
  71.  
  72.  
  73. %%%%%%%%%%%%%%%%%%%%%%% RESTRICTIONS ON USE %%%%%%%%%%%%%%%%%%%%%%%
  74.  
  75. Files in this package may only be distributed or changed according
  76. to the following restrictions.
  77.  
  78.  
  79. Distribution of unchanged versions:
  80.  
  81.   You are NOT ALLOWED to take money for the distribution or use of
  82.   these files except for a nominal charge for copying, etc.
  83.  
  84.   Redistribution of unchanged files is allowed provided that all files
  85.   listed in this readme file are distributed together.
  86.  
  87.   If you receive only some of these files from someone, complain!
  88.  
  89.  
  90. Generation and distribution of changed versions:
  91.  
  92.   The generation of changed versions of the files included in the
  93.   packages is allowed under the following restrictions:
  94.  
  95.   - Rename the file before you make any changes to it.
  96.  
  97.   - Acknowledge the origin of the changed version in the file and
  98.     keep the information that it (or a changed version) has to be
  99.     distributed under the restrictions mentioned in this file.
  100.  
  101.   - Change any ERROR REPORT address so that we don't get error
  102.     reports for files *not* maintained by us.
  103.  
  104.  
  105. The distribution of changed versions of the files included in the
  106. package is allowed under the following restrictions:
  107.  
  108.   - Provide the user with information how to obtain the original
  109.     package or, even better, distribute it with your files.
  110.  
  111.   - Make sure that the changed versions contain a notice that
  112.     prevents others from taking money for distribution or use of your
  113.     files, i.e., they have to be distributed under the restrictions
  114.     mentioned in this file.
  115.  
  116.  
  117. %%%%%%%%%%%%%%%%%%%%%%% REVTeX DISTRIBUTION %%%%%%%%%%%%%%%%%%%%%%%
  118.  
  119. Files in the complete REVTeX 3.0 distribution:
  120.  
  121.   (a) the general files:
  122.       README           % this file
  123.       revtex.sty       % main style file
  124.       manintro.tex     % introduction for input guide
  125.       manend.tex       % appendixes for input guide
  126.   (b) AIP-specific files
  127.       manaip.tex       % AIP chapter for input guide
  128.   (c) APS-specific files
  129.       aps.sty          % main society-specific style file for APS macros
  130.       aps10.sty        % internally called style for galley-format output
  131.       aps12.sty        % internally called style for preprint-format output
  132.       apssamp.tex      % sample file
  133.       manaps.tex       % APS chapter for input guide
  134.       prabib.sty       % internally called style for normal-style citations
  135.       prbbib.sty       % internally called style for PRB-style citations
  136.       prsty.bst        % Physical Review--style BibTeX style file
  137.       reftest.tex      % Citation and bibliography analyzer
  138.       template.aps     % template file; copy to filename.tex and edit that file
  139.       version2.sty     % style file for running v2.x REVTeX files in v3.0
  140.   (d) OSA-specific files
  141.       osa.sty          % Society-specific style file for OSA journals
  142.       osa10.sty        % Fonts and format style file for OSA journals
  143.       osa12.sty        % Fonts and format style file for OSA journals
  144.       osabib.sty       % Society file for bibliography style
  145.       template.tex     % OSA template for creating a manuscript
  146.       sample.tex       % a longer sample of REVTeX use
  147.       manosa.tex       % OSA chapter for input guide
  148.       josaa.tex        % sample JOSA A paper
  149.       josab.tex        % sample JOSA B paper
  150.       aplop.tex        % sample Applied Optics paper
  151.  
  152.  
  153. %%%%%%%%%%%%%%%%%%%%%%% GETTING STARTED %%%%%%%%%%%%%%%%%%%%%%%
  154.  
  155. You must have TeX and LaTeX running to use these macros. All macros
  156. run on a standard LaTeX format.
  157.  
  158. Installing to just test the macros can be accomplished by copying all the
  159. files into an unused directory, then changing to that directory. All the
  160. files and facilities of REVTeX should then be usable while you are in that
  161. directory.
  162.  
  163. A more permanent installation would usually mean installing the .sty files
  164. and reftest.tex file into the directory where TeX usually looks for input
  165. files, the .bst files into the directory where BibTeX usually looks for its
  166. style files, and the rest of the files into a REVTeX working directory or a
  167. public directory, depending on your system setup. Care should be taken to
  168. avoid writing over files already present. The files in the REVTeX package have
  169. been named to help avoid this problem, but there can be no guarantee that
  170. our file names are unique.
  171.  
  172. If you are permanently upgrading an older version of REVTeX (<3.0), the files
  173. from the old version should be removed first. You may delete these files or
  174. save them somewhere where they will not be found by TeX when it looks for
  175. style files. Here is a list of the older files:
  176.  
  177.       readme        % make sure you only delete the REVTeX readme!
  178.       revtex.sty
  179.       aps.sty
  180.       aps10.sty
  181.       aps12.sty
  182.       preprint.sty
  183.       eqsecnum.sty
  184.       smplea.tex
  185.       smpleb.tex
  186.       smplec.tex
  187.       apguide.tex
  188.  
  189. Older versions of REVTeX (<3.0) will not coexist with this version.
  190.  
  191. The next thing you need to do is run LaTeX on the files for the input guide.
  192. The input guide consists of common introductory material (manintro.tex),
  193. society-specific chapters (manaps.tex for APS, manosa.tex for OSA, and
  194. manaip.tex for AIP), and common appendixes (manend.tex). Run LaTeX on, and
  195. print, manintro.tex, the desired society-specific chapters, and manend.tex.
  196. Gathering the printed material together in order will provide all needed
  197. information. There is a general table of contents in manintro.tex, and
  198. separate tables of contents in each society's chapter. Carefully read the
  199. intructions in the appropriate chapter of the Input Guide. The sample file(s)
  200. and template will also contain useful examples and explanations.
  201.  
  202. You may get a number of "Underfull \hbox . . ." messages when running the
  203. documentation and samples; these are normal. Also, you may need to LaTeX
  204. these files three times to complete all references and build the table of
  205. contents.
  206.  
  207. If needed, consult a local (La)TeX user or system support person for
  208. information on how to run LaTeX and print its output on your local system.
  209.  
  210.  
  211. %%%%%%%%%%%%%%%%%%%%%%% ERROR REPORTS %%%%%%%%%%%%%%%%%%%%%%%
  212.  
  213. Before you report an error please check that
  214.  
  215.   - the error isn't caused by obsolete versions of other software.
  216.     LaTeX from 1986 is a good candidate; for example, negative indents
  217.     (outdents) following an equation environment.
  218.  
  219.   - you use an original version of the package.
  220.  
  221.  
  222. If you think you have found a genuine bug please report it, together
  223. with the following information:
  224.  
  225.   - version of the REVTeX file(s)
  226.  
  227.   - version (date!) of your LaTeX
  228.  
  229.   - a short test file showing the behavior with all unnecessary
  230.     coding removed. The log file showing the problem might also help.
  231.  
  232.  
  233. Errors should be reported to the person listed in your copy of the
  234. user guide.
  235.